home *** CD-ROM | disk | FTP | other *** search
/ Stone Design / Stone Design.iso / Stone_Friends / Wave / WavesWorld / Source / Libraries / tcl7.4b3 / doc / Backslash.3 < prev    next >
Encoding:
Text File  |  1994-12-17  |  1.2 KB  |  46 lines
  1. '\"
  2. '\" Copyright (c) 1989-1993 The Regents of the University of California.
  3. '\" Copyright (c) 1994 Sun Microsystems, Inc.
  4. '\"
  5. '\" See the file "license.terms" for information on usage and redistribution
  6. '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
  7. '\" 
  8. '\" @(#) Backslash.3 1.13 94/12/17 16:17:07
  9. '\" 
  10. .so man.macros
  11. .HS Tcl_Backslash tclc
  12. .BS
  13. .SH NAME
  14. Tcl_Backslash \- parse a backslash sequence
  15. .SH SYNOPSIS
  16. .nf
  17. \fB#include <tcl.h>\fR
  18. .sp
  19. char
  20. \fBTcl_Backslash\fR(\fIsrc, countPtr\fR)
  21. .SH ARGUMENTS
  22. .AS char *countPtr
  23. .AP char *src in
  24. Pointer to a string starting with a backslash.
  25. .AP int *countPtr out
  26. If \fIcountPtr\fR isn't NULL, \fI*countPtr\fR gets filled
  27. in with number of characters in the backslash sequence, including
  28. the backslash character.
  29. .BE
  30.  
  31. .SH DESCRIPTION
  32. .PP
  33. This is a utility procedure used by several of the Tcl
  34. commands.  It parses a backslash sequence and returns
  35. the single character corresponding to the sequence.
  36. \fBTcl_Backslash\fR modifies \fI*countPtr\fR to contain the number
  37. of characters in the backslash sequence.
  38. .PP
  39. See the Tcl manual entry for information on the valid
  40. backslash sequences.
  41. All of the sequences described in the Tcl
  42. manual entry are supported by \fBTcl_Backslash\fR.
  43.  
  44. .SH KEYWORDS
  45. backslash, parse
  46.